Crate utcnow

utcnow — Get the current unixtime in a no-std context

This library solves one question, and one question only: What’s the time?

In UTC, and according to the clock of the PC, tablet, toaster … the library runs on, expressed as seconds + nanoseconds since 1970-01-01.

let now = utcnow().unwrap();
let seconds = now.as_secs();
let nanos = now.subsec_nanos();

For many target platforms this call cannot fail. If this is true for the current target, then the constant INFALLIBLE will be true.

If the target platform is not supported, then utcnow() will always return an error instead of failing to compile. Use the library with default-features = false and without the feature "fallback" to get a compile-time error instead.

The feature "std" (enabled by default) is only needed if you need the Error type to implement std::error::Error.

Supported platforms

If you have successfully tested one of the untested targets, then please tell me. And if not, then even more so!

If you know how to implement another target, then please open a pull request.

Supported and tested:

• Android
• Emscripten
• FreeBSD
• Haiku
• Illumos
• Linux
• Linux with Musl
• MacOS
• NetBSD
• WASI
• wasm32
• Windows

(Probably) supported, but not actually tested:

• Darwin
• Dragonfly
• Fuchsia
• iOS
• OpenBSD
• Redox
• Solaris

Increasing the msrv for tier-2 or lower platforms will not be indicated as a breaking change to the semver version.

Feature flags

utcnow has the following optional features:

• serde, which implements serde::Deserialize and serde::Serialize for UtcTime.

• arbitrary, which implements the arbitrary::Arbitrary trait for UtcTime.

• proptest, which implements the proptest::arbitrary::Arbitrary trait for UtcTime.

• quickcheck, which implements the quickcheck::Arbitrary trait for UtcTime.

• rkyv, which implements the rkyv::Archive, rkyv::Serialize, and rkyv::Deserialize for UtcTime.

• castaway, which implements the castaway::LifetimeFree trait for UtcTime.

Modules

• changelog
  Changes between the versions

Structs

• ConversionError
  Could not convert from or to a UtcTime
• Error
  Could not query system time
• UtcTime
  A Unix time, i.e. seconds since 1970-01-01 in UTC

Constants

• IMPLEMENTED
  true if getting the time is implemented for the target platform
• INFALLIBLE
  true if utcnow() cannot fail

Functions

• utcnow
  Get the current unix time, seconds since 1970-01-01 in UTC

Type Aliases

• Result
  A result type that default to Error as error type